home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 1 / The Arsenal Files (Arsenal Computer).ISO / novell / mhs183.exe / SYS.EXE / RECORDS.DOC < prev    next >
Text File  |  1993-08-03  |  17KB  |  462 lines
  1. MHS Tracking and Statistics File Format
  2. Tue 11-Dec-90
  3. -----------------------------------------------------------------
  4. If you enter a directory name (with no filename) in the "Stats"
  5. field of the SET UP TRANSPORT menu, three or more files will be
  6. created when the Connectivity Manager is started.  Each will have
  7. the name of your host and the names of all passive internet hosts
  8. that your host connects to, with the following extensions:
  9.  
  10.     hostname.Cnn
  11.     hostname.Tnn
  12.     hostname.Rnn
  13.  
  14. The "C", "T", and "R" in the filename extension refer to the type
  15. of tracking file being generated.  Files whose extensions begin
  16. with a "C" are "Call Record" files.  Those whose extensions begin
  17. with "T" are "Transfer Record" files, and those whose extensions
  18. begin with "R" are "Routing Record" files.
  19.  
  20. The two digit numbers in the filename extensions refer to the hub
  21. line whose records are being kept in the file.  The first line
  22. will have records whose extensions end in "00".  The second line
  23. will have files whose extensions end in "01", and so forth.
  24.  
  25. Tracking records are kept in a comma-delimited format, readable
  26. by most database programs.  Details of the record structures are
  27. given below.
  28.  
  29. The first record in all tracking files is an ID record which
  30. indicates the type of record file, the host for which the file is
  31. being kept, and when the file was created.  The ID record has the
  32. following format:
  33.  
  34. int rectype
  35.             The record type for ID records is 0.
  36.  
  37. string  filnam
  38.             This file's full pathname
  39.  
  40. string  hostname
  41.             This host's name
  42.  
  43. string  hostsn
  44.             This host`s serial number
  45.  
  46. int dayofweek
  47.             Day of the week that the call occured.  This field
  48.             allows different billing rates to be used based on
  49.             day of week without requiring calculation from date.
  50.             Sunday:    1
  51.             Monday:    2
  52.             Tuesday:   3
  53.             Wednesday: 4
  54.             Thursday:  5
  55.             Friday:    6
  56.             Saturday:  7
  57.  
  58. DATE date
  59.             Current date in the format "dd/mm/yy"
  60.  
  61. int time
  62.             Current time in minutes since midnight
  63.  
  64.  
  65. CALL Records
  66.  
  67. A call record is made for every call from or to a host
  68. connectivity manager line including all internet and gateway
  69. sessions, plus every routing session during which messages are
  70. routed, plus every MHS Utilities Session during which a queue has
  71. been reposted or messages in a queue have been reposted or
  72. returned to their sender.
  73.  
  74. The Call-ID in each call record can be used to correlate calls to
  75. particular messages identified in Transfer records that were
  76. transferred or processed during the call.
  77.  
  78. int rectype
  79.             Call record entries have the number "1" in this field
  80.  
  81. int dayofweek
  82.             Day of the week that the call occured.  This field
  83.             allows different billing rates to be used based on
  84.             day of week without requiring calculation from date.
  85.             Sunday:    1
  86.             Monday:    2
  87.             Tuesday:   3
  88.             Wednesday: 4
  89.             Thursday:  5
  90.             Friday:    6
  91.             Saturday:  7
  92.  
  93. DATE date
  94.             Current date in the format "dd/mm/yy"
  95.  
  96. int time
  97.             Current time in minutes since midnight
  98.  
  99. string OrgAns
  100.             Session Originator:
  101.                 "O" == Originate
  102.                 "A" == Answer
  103.  
  104.             Notes:
  105.             Internet sessions while the host is sending a queue
  106.             to a remote host are logged as "O", and while the
  107.             host is bursting a queue received from an internet
  108.             remote host is logged as "A".
  109.  
  110.             Gateway sessions are logged as "O".
  111.  
  112. string SessionID
  113.             Session ID of this session
  114.  
  115.             Notes: The session ID is a unique ID generated in the
  116.             format of a Message-ID at the beginning of a session.
  117.             This number is used only for correlating call records
  118.             with Transfer records.
  119.  
  120. string RemoteHost
  121.             Name of the Host that this session is with
  122.  
  123. string RemoteSerNum
  124.             Serial Number of the remote host
  125.  
  126. int SessionVer
  127.             Session Protocol version
  128.             Note:
  129.             The session protocol used by a host is the same as
  130.             the host's version.
  131.  
  132. int LinkVer
  133.             Link Protocol version used during the session.
  134.             Note:
  135.             The value 0 is used for Gateway and Internet sessions.
  136.  
  137. int TotDuration
  138.             Total session time including call setup and hangup.
  139.             Note:
  140.             The difference between TotDuration and the sum of
  141.             OutDuration and InDuration is the overhead for
  142.             establishing the call.
  143.  
  144. int OutDuration
  145.             Total Inbound message transfer time in seconds.
  146.  
  147. int InDuration
  148.             Total Outbound message transfer time in seconds.
  149.  
  150. int contype
  151.             Session type code:
  152.                 0 = local submission/delivery/routing session
  153.                 1 = Session with a Host that can be called.
  154.                 2 = Session with a Host that calls this host.
  155.                 3 = Session with a Host reached via an Internet
  156.                 4 = Session transferring messages to/from Gateway
  157.                 10 = Discard Queue session from MHSU
  158.  
  159. int speed
  160.             Raw data transfer speed:  (examples:)
  161.                                      0    (Internet and Gateway)
  162.                                    300 bps
  163.                                   1200 bps
  164.                                   2400 bps
  165.                                   4800 bps
  166.                                   9600 bps
  167. int rescode
  168.             connection result code
  169.                                   0 == All OK
  170.                                   1 == Partial transfer
  171.                                   2 == Failed transfer
  172.                                 127 == Fatal error during transfer
  173.                                 255 == Unknown error during transfer
  174.  
  175.             Notes:
  176.             "Failed transfer" means that the initial login
  177.             negotiation with the remote host did not succeed.
  178.             The record will indicate -Unknown- for the hostname
  179.             and serial number when a remote host calls in under
  180.             these circumstances.
  181.  
  182. The following are sample call records including a sample file ID record:
  183.  
  184. 0, F:\tgb\mhs\stats\syscorp.C00, syscorp, HBGNPBBCHL, 6,06/04/90,941
  185. 1,6,06/04/90,953,O,35CB1C26017B12F1,host1,HBGAPBBCHL,70,0,0,0,0,3,0,0
  186. 1,6,06/04/90,954,A,61CB1C26017B12F1,host2,HBGNEKGMGN,70,64,234,0,210,2,9600,2
  187. 1,6,06/04/90,958,O,50CC1C26017B12F1,,,0,0,3,0,0,0,0,0
  188. 1,6,06/04/90,959,O,93CC1C26017B12F1,host1,HBGAPBBCHL,70,0,2,2,0,3,0,0
  189. 1,6,06/04/90,966,O,37CE1C26017B12F1,host3,HBGNEKGMGN,70,64,318,0,261,1,9600,2
  190.  
  191.  
  192. TRANSFER Records
  193.  
  194. Transfer records record the "appearance" and "disappearance" of
  195. messages at a host.  Each entry reflects a message entry or an
  196. associated attachment entry.  For example, a version 64 queue
  197. with a single message and its attachment will produce two
  198. transfer records.
  199.  
  200. A transfer record is created when an entry arrives at a host, and
  201. later when the entry is delivered or transfered from the host.
  202.  
  203. When a version 70 transfer is partially transferred, more than
  204. one instance of the transfer will appear in transfer records,
  205. with smaller than the total volume, and with a code indicating
  206. that each transmission consisted of only part of the transfer.
  207. Version 64 entries, on the other hand, are transfered in their
  208. totality, or not at all.
  209.  
  210. Transfer records can be correlated to particular calling sessions
  211. using the Session-ID which appears in both Entry and Call
  212. records, and can be correlated to particular routing activities
  213. using the MHS-ID, which appears in both Call and Routing records.
  214.  
  215. Transfer Records have the following format:
  216.  
  217. int rectype
  218.             Transfer records have a record type 3
  219.  
  220. string SessionID
  221.             Session ID of this session
  222.  
  223.             Notes: The session ID is a unique ID generated in the
  224.             format of a Message-ID at the beginning of a session.
  225.             This number is used only for correlating call records
  226.             with Transfer and Routing records.
  227.  
  228. string MHS-ID
  229.             MHS-ID of entry
  230.  
  231.             Note: The MHS-ID is generated when an entry enters a
  232.             version 70 host, and remains associated with all
  233.             instances of the entry as long as the entry stays in
  234.             a version 70 environment.  In a pure version 70
  235.             environment, this ID can be used to track an entry
  236.             message through a network.
  237.  
  238.             The MHS-ID field is also used to correlate Transfer
  239.             records with Routing records.
  240.  
  241.             A v70 multiple attachment message is associated with
  242.             a single transfer record.  If that message is burst
  243.             into multiple v64 entries, a single transfer record
  244.             continues to specify the sum of the v64 entries with
  245.             the same MHS-ID that are now each carrying different
  246.             attachments.
  247.  
  248. int duration
  249.             Transfer time in seconds
  250.  
  251.             This number is determined during version 70 sessions,
  252.             and is calculated from the review of incoming and
  253.             outbound version 64 queues and the total duration of
  254.             the session during which those queues were
  255.             transfered.
  256.  
  257. string direction
  258.             Direction of transfer of this entry recorded by this
  259.             entry record.
  260.  
  261.             "I" indicates INBOUND, local submission, arrived from
  262.             inbound transfer.
  263.  
  264.             "O" indicates OUTBOUND, outbound from the host: local
  265.             delivery, discarded queue, or non-delivery discard.
  266.  
  267. long charcnt
  268.             Number of bytes in entry transferred.
  269.  
  270.             Notes:
  271.             This is the total for the particular instance being
  272.             recorded.  There is a transfer record for each
  273.             instance of a message and for each of its
  274.             attachments.  The transfer record shows the charcnt
  275.             of the particular instance of the message or its
  276.             attachment being recorded.
  277.  
  278. int SequenceNumber
  279.             0 for message body, and 1 through n for each
  280.             attachment.
  281.  
  282. int rescode
  283.             Transfer result code
  284.                 0 = All OK
  285.                 1 = Partial transfer
  286.               255 = Unknown error
  287.  
  288.             Note: Some errors won't be logged because the system
  289.             crashed and the volume to which logging is done can't
  290.             be accessed.
  291.  
  292. The following are sample transfer records including a sample file ID record:
  293.  
  294. 0, F:\tgb\mhs\stats\ati-fast.T00, ati-fast, HBGNPBBCHL, 6,06/04/90,941
  295. 3,61CB1C26017B12F1,F2BB1C2601EC0F4A,2,I,672,0,0
  296. 3,61CB1C26017B12F1,F8D61C2601EC0F4A,3,I,793,0,0
  297. 3,61CB1C26017B12F1,F8D61C2601EC0F4A,204,I,63280,1,1
  298. 3,93CC1C26017B12F1,F2BB1C2601EC0F4A,0,O,666,0,0
  299. 3,37CE1C26017B12F1,F8D61C2601EC0F4A,0,I,0,0,0
  300. 3,37CE1C26017B12F1,F8D61C2601EC0F4A,259,I,83168,1,1
  301. 3,27D81C26017B12F1,F8D61C2601EC0F4A,0,I,0,0,0
  302.  
  303.  
  304. ROUTING records
  305.  
  306. Routing Records record the actions generated by routing and queue
  307. maintenance operations.
  308.  
  309. Routing Records have the following format:
  310.  
  311. int rectype
  312.             Routing records have record type 2
  313.  
  314. string SessionID
  315.             Session ID of the session during which the message
  316.             was submitted to this host for routing.
  317.  
  318.             Notes: The session ID is a unique ID generated in the
  319.             format of a Message-ID at the beginning of a session.
  320.             This number is used only for correlating call records
  321.             with Transfer and Routing records.
  322.  
  323. string MHS-ID
  324.             MHS-ID of entry being routed
  325.  
  326.             This ID can be used to correlate routing records to
  327.             in- and outbound Transfer records.
  328.  
  329. string SenderUser
  330.             User name of Sender
  331.  
  332. string SenderApp
  333.             Application name of Sender
  334.  
  335. string SenderWG
  336.             Workgroup name of Sender
  337.  
  338. string SenderEnt
  339.             Enterprise name of Sender
  340.             Note: This field will always be empty in routing
  341.             records produced by MHS 1.5.
  342.  
  343. string RecipUser
  344.             User name of Recipient
  345.  
  346. string RecipApp
  347.             Application name of Recipient
  348.  
  349. string RecipWG
  350.             Workgroup name of Recipient
  351.  
  352. string RecipEnt
  353.             Enterprise name of Recipient
  354.             Note: This field will always be empty in routing
  355.             records produced by MHS 1.5.
  356.  
  357. string QueuedTo
  358.  
  359.             Name of Queue to which entry was queues.
  360.  
  361.             Notes:
  362.             -Here- in this field means the message was delivered
  363.             to a local user.
  364.  
  365.             -ERROR- in this field means the message was discarded
  366.             as undeliverable.
  367.  
  368.             -SND- in this field means the message was reposted to
  369.             the SND directory.
  370.  
  371. string XRecipUser
  372.             Transformed User name of Recipient.
  373.  
  374.             Note: If no transformation was performed then this
  375.             field is empty (represented as two consecutive
  376.             commas.
  377.  
  378. string XRecipApp
  379.             Transformed Application name of Recipient.
  380.  
  381.             Note:  If no transformation was performed then this
  382.             field is empty (represented as two consecutive
  383.             commas.
  384.  
  385. string XRecipWG
  386.             Transformed Workgroup name of Recipient.
  387.  
  388.             Note: If no transformation was performed then this
  389.             field is empty (represented as two consecutive
  390.             commas.
  391.  
  392. string XRecipEnt
  393.             Transformed Enterprise name of Recipient.
  394.  
  395.             Notes: If no transformation was performed then this
  396.             field is empty (represented as two consecutive
  397.             commas.
  398.  
  399.             This field will always be empty in routing
  400.             records produced by MHS 1.5.
  401.  
  402. int QtyAtts
  403.  
  404.             Number of Attachment-type entries being routed with
  405.             this message entry. (0 through 64)
  406.  
  407. int V64AttBursting
  408.  
  409.             "1" or "0".  If the value of this field is 1, then
  410.             a new message body entry was output for each
  411.             attachment specified in QtyAttsIn.  If the value of
  412.             this field is 0, then only the original message entry
  413.             was output as a result of this routing operation.
  414.  
  415. int ErrorBurstMultiplier
  416.  
  417.             Number of values in the Addresses-referred-to field,
  418.             about which a complete set of messages is being
  419.             generated.  This number is 1 if there is no
  420.             Addresses-referred-to field or if the message is not
  421.             a -Maiser- being burst due to its being a V70 to V64
  422.             conversion and multiple Addresses are referred to,
  423.             and is equal to the number of Addresses-referred-to
  424.             when a Maiser message referring to multiple errors is
  425.             burst at a V70 to V64 boundary.
  426.  
  427.             Notes regarding the previous three fields:
  428.  
  429.                 Using the fields QtyAttsIn, V64AttBursting, and
  430.                 ErrorBurstMultiplier, the number of outbound
  431.                 transfer records due to a particular routing
  432.                 operation can be calculated:
  433.  
  434.             (1 + QtyAttsIn + ((QtyAttsIn * V64AttBursting)-1)   )
  435.  
  436.                         * ErrorBurstMultiplier
  437.  
  438.                 The initial "1" accounts for the message input to
  439.                 the router.
  440.  
  441.                 The QtyAttsIn accounts for the number of entries
  442.                 attributable to attachments associated with the
  443.                 message -- these will always be output.
  444.  
  445.                 The ((QtyAttsIn * V64AttBursting)-1) accounts for
  446.                 the number of new message body entries output due
  447.                 to v70 to v64 attachment bursting.
  448.  
  449.                 The * ErrorBurstMultiplier gives a multiplier to
  450.                 the above quantity of entries to account for
  451.                 messages spawned due to V70 to V64 multiple
  452.                 error-report bursting.
  453.  
  454. The following are sample routing records including a sample file ID record:
  455.  
  456. 0, F:\tgb\mhs\stats\ati-fast.R00, ati-fast, HBGNPBBCHL, 6,06/04/90,941
  457. 2,37CE1C26017B12F1,F2BB1C2601EC0F4A,MSmith,,WG1,,John,ATC,ati,,host1,,,,,0,0,0
  458. 2,37CE1C26017B12F1,F8D61C2601EC0F4A,dmark,ATC,WG1,,tjones,ATC,WG1,,host1,,,,,1,0,0
  459. 2,27D81C26017B12F1,F8D61C2601EC0F4A,dmark,ATC,WG1,,tjones,ATC,WG1,,host1,,,,,1,0,0
  460.  
  461.  
  462.